<?php

namespace jwt;

use ArrayAccess;
use DateTime;
use DomainException;
use Exception;
use InvalidArgumentException;
use OpenSSLAsymmetricKey;
use UnexpectedValueException;

/**
 *基于此规范的JSON Web令牌实现：
 *https://tools.ietf.org/html/rfc7519
 *
 *PHP版本5
 *
 *@category身份验证
 *@package Authentication_JWT
 *@licensehttp://opensource.org/licenses/BSD-3-Clause3语句BSD
 *@linkhttps://github.com/firebase/php-jwt
 */
class JWT
{
    const ASN1_INTEGER = 0x02;
    const ASN1_SEQUENCE = 0x10;
    const ASN1_BIT_STRING = 0x03;

    /**
     *当检查nbf、iat或到期时间时，
     *我们想给
     *解释时钟偏斜。
     */
    public static $leeway = 0;

    /**
     *允许指定当前时间戳。
     *用于在单元测试中固定值。
     *
     *如果为null，将默认为PHP时间（）值。
     */
    public static $timestamp = null;

    public static $supported_algs = array(
        'ES384' => array('openssl', 'SHA384'),
        'ES256' => array('openssl', 'SHA256'),
        'HS256' => array('hash_hmac', 'SHA256'),
        'HS384' => array('hash_hmac', 'SHA384'),
        'HS512' => array('hash_hmac', 'SHA512'),
        'RS256' => array('openssl', 'SHA256'),
        'RS384' => array('openssl', 'SHA384'),
        'RS512' => array('openssl', 'SHA512'),
        'EdDSA' => array('sodium_crypto', 'EdDSA'),
    );

    /**
     *将JWT字符串解码为PHP对象。
     *
     *@param string$jwt jwt
     *@param Key|array＜Key＞|mixed$keyOrKeyArray Key或Key对象的数组。
     *如果使用的算法是不对称的，则这是公钥
     *每个Key对象都包含一个算法和匹配密钥。
     *支持的算法有“ES384”、“S256”、“HS256”、“HS384”、，
     *“HS512”、“RS256”、“RS 384”和“RS512”
     *@param array$allowed_algs[DEPRECATED]支持的验证算法列表。只有
     *应用于向后兼容性。
     *
     *@return object JWT作为PHP对象的负载
     *
     *@throws InvalidArgumentException提供的JWT为空
     *@throws UnexpectedValueException提供的JWT无效
     *@throws SignatureInvalidException提供的JWT无效，因为签名验证失败
     *@throws BeforeValidException提供的JWT在符合“nbf”定义的条件之前正在尝试使用
     *@throws BeforeValidException提供的JWT在按照“iat”定义创建之前正在尝试使用
     *@throws ExpiredException提供的JWT已过期，如“exp”声明所定义
     *
     *@使用jsonDecode
     *@使用urlsafeB64代码
     */
    public static function decode($jwt, $keyOrKeyArray, array $allowed_algs = array())
    {
        $timestamp = \is_null(static::$timestamp) ? \time() : static::$timestamp;

        if (empty($keyOrKeyArray)) {
            throw new InvalidArgumentException('Key may not be empty');
        }
        $tks = \explode('.', $jwt);
        if (\count($tks) != 3) {
            throw new UnexpectedValueException('Wrong number of segments');
        }
        list($headb64, $bodyb64, $cryptob64) = $tks;
        if (null === ($header = static::jsonDecode(static::urlsafeB64Decode($headb64)))) {
            throw new UnexpectedValueException('Invalid header encoding');
        }
        if (null === $payload = static::jsonDecode(static::urlsafeB64Decode($bodyb64))) {
            throw new UnexpectedValueException('Invalid claims encoding');
        }
        if (false === ($sig = static::urlsafeB64Decode($cryptob64))) {
            throw new UnexpectedValueException('Invalid signature encoding');
        }
        if (empty($header->alg)) {
            throw new UnexpectedValueException('Empty algorithm');
        }
        if (empty(static::$supported_algs[$header->alg])) {
            throw new UnexpectedValueException('Algorithm not supported');
        }

        list($keyMaterial, $algorithm) = self::getKeyMaterialAndAlgorithm(
            $keyOrKeyArray,
            empty($header->kid) ? null : $header->kid
        );

        if (empty($algorithm)) {
            //使用不推荐使用的“allowed_algs”来确定是否支持该算法。
            //这在某些实现中打开了攻击的可能性。
            //@seehttps://github.com/firebase/php-jwt/issues/351
            if (!\in_array($header->alg, $allowed_algs)) {
                throw new UnexpectedValueException('Algorithm not allowed');
            }
        } else {
            // Check the algorithm
            if (!self::constantTimeEquals($algorithm, $header->alg)) {
                // See issue #351
                throw new UnexpectedValueException('Incorrect key for this algorithm');
            }
        }
        if ($header->alg === 'ES256' || $header->alg === 'ES384') {
            // OpenSSL expects an ASN.1 DER sequence for ES256/ES384 signatures
            $sig = self::signatureToDER($sig);
        }

        if (!static::verify("$headb64.$bodyb64", $sig, $keyMaterial, $header->alg)) {
            throw new SignatureInvalidException('Signature verification failed');
        }

        //检查nbf是否已定义。这是
        //实际上可以使用令牌。如果还没有到那个时间，请中止。
        if (isset($payload->nbf) && $payload->nbf > ($timestamp+static::$leeway)) {
            throw new BeforeValidException(
                'Cannot handle token prior to ' . \date(DateTime::ISO8601, $payload->nbf)
            );
        }

        //请检查此令牌是否已在“现在”之前创建。这样可以防止
        //使用为以后使用而创建的令牌
        //正确使用nbf声明）。
        if (isset($payload->iat) && $payload->iat > ($timestamp+static::$leeway)) {
            throw new BeforeValidException(
                'Cannot handle token prior to ' . \date(DateTime::ISO8601, $payload->iat)
            );
        }

        // Check if this token has expired.
        if (isset($payload->exp) && ($timestamp-static::$leeway) >= $payload->exp) {
            throw new ExpiredException('Expired token');
        }

        return $payload;
    }

    /**
     *将PHP对象或数组转换并签名为JWT字符串。
     *
     *@param object | array$payload PHP对象或数组
     *@param string|resource$key密钥。
     *如果使用的算法是不对称的，这就是私钥
     *@param string$alg签名算法。
     *支持的算法有“ES384”、“S256”、“HS256”、“HS384”、，
     *“HS512”、“RS256”、“RS 384”和“RS512”
     *@param混合$keyId
     *@param array$head一个带有要附加的头元素的数组
     *
     *@return string A签名JWT
     *
     *@使用jsonEncode
     *@使用urlsafeB64编码
     */
    public static function encode($payload, $key, $alg = 'HS256', $keyId = null, $head = null)
    {
        $header = array('typ' => 'JWT', 'alg' => $alg);
        if ($keyId !== null) {
            $header['kid'] = $keyId;
        }
        if (isset($head) && \is_array($head)) {
            $header = \array_merge($head, $header);
        }
        $segments = array();
        $segments[] = static::urlsafeB64Encode(static::jsonEncode($header));
        $segments[] = static::urlsafeB64Encode(static::jsonEncode($payload));
        $signing_input = \implode('.', $segments);

        $signature = static::sign($signing_input, $key, $alg);
        $segments[] = static::urlsafeB64Encode($signature);

        return \implode('.', $segments);
    }

    /**
     *使用给定的密钥和算法对字符串进行签名。
     *
     *@param string$msg要签名的消息
     *@param string|resource$key密钥
     *@param string$alg签名算法。
     *支持的算法有“ES384”、“S256”、“HS256”、“HS384”、，
     *“HS512”、“RS256”、“RS 384”和“RS512”
     *
     *@return string加密消息
     *
     *@throws DomainException指定了不支持的算法或错误的密钥
     */
    public static function sign($msg, $key, $alg = 'HS256')
    {
        if (empty(static::$supported_algs[$alg])) {
            throw new DomainException('Algorithm not supported');
        }
        list($function, $algorithm) = static::$supported_algs[$alg];
        switch ($function) {
            case 'hash_hmac':
                return \hash_hmac($algorithm, $msg, $key, true);
            case 'openssl':
                $signature = '';
                $success = \openssl_sign($msg, $signature, $key, $algorithm);
                if (!$success) {
                    throw new DomainException("OpenSSL unable to sign data");
                }
                if ($alg === 'ES256') {
                    $signature = self::signatureFromDER($signature, 256);
                } elseif ($alg === 'ES384') {
                    $signature = self::signatureFromDER($signature, 384);
                }
                return $signature;
            case 'sodium_crypto':
                if (!function_exists('sodium_crypto_sign_detached')) {
                    throw new DomainException('libsodium is not available');
                }
                try {
                    // The last non-empty line is used as the key.
                    $lines = array_filter(explode("\n", $key));
                    $key = base64_decode(end($lines));
                    return sodium_crypto_sign_detached($msg, $key);
                } catch (Exception $e) {
                    throw new DomainException($e->getMessage(), 0, $e);
                }
        }
    }

    /**
     *使用消息、密钥和方法验证签名。并非所有方法
     *是对称的，所以我们必须有一个单独的验证和签名方法。
     *
     *@param string$msg原始消息（标头和正文）
     *@param string$signature原始签名
     *@param string|resource$key对于HS*，字符串键有效。对于RS*，必须是openssl公钥的资源
     *@param string$alg算法
     *
     *@return bool
     *
     *@throws DomainException算法无效、密钥错误或OpenSSL失败
     */
    private static function verify($msg, $signature, $key, $alg)
    {
        if (empty(static::$supported_algs[$alg])) {
            throw new DomainException('Algorithm not supported');
        }

        list($function, $algorithm) = static::$supported_algs[$alg];
        switch ($function) {
            case 'openssl':
                $success = \openssl_verify($msg, $signature, $key, $algorithm);
                if ($success === 1) {
                    return true;
                } elseif ($success === 0) {
                    return false;
                }
                // returns 1 on success, 0 on failure, -1 on error.
                throw new DomainException(
                    'OpenSSL error: ' . \openssl_error_string()
                );
            case 'sodium_crypto':
                if (!function_exists('sodium_crypto_sign_verify_detached')) {
                    throw new DomainException('libsodium is not available');
                }
                try {
                    $lines = array_filter(explode("\n", $key));
                    $key = base64_decode(end($lines));
                    return sodium_crypto_sign_verify_detached($signature, $msg, $key);
                } catch (Exception $e) {
                    throw new DomainException($e->getMessage(), 0, $e);
                }
            case 'hash_hmac':
            default:
                $hash = \hash_hmac($algorithm, $msg, $key, true);
                return self::constantTimeEquals($signature, $hash);
        }
    }

    /**
     *将JSON字符串解码为PHP对象。
     *
     *@param string$input JSON字符串
     *
     *@return object JSON字符串的对象表示
     *
     *@throws DomainException提供的字符串是无效的JSON
     */
    public static function jsonDecode($input)
    {
        if (\version_compare(PHP_VERSION, '5.4.0', '>=') && !(\defined('JSON_C_VERSION') && PHP_INT_SIZE > 4)) {
            /**在PHP>=5.4.0中，json_decode（）接受一个选项参数，该参数允许
             *指定大型int（如Steam事务ID）应被视为
             *字符串，而不是将它们转换为浮点的PHP默认行为。
             */
            $obj = \json_decode($input, false, 512, JSON_BIGINT_AS_STRING);
        } else {
            /**然而，并不是所有的服务器都支持这一点，因此对于旧版本，我们必须
             *手动检测JSON字符串中的大型int并引用它们（从而转换
             *它们转换为字符串），因此调用preg_replace（）。
             */
            $max_int_length = \strlen((string) PHP_INT_MAX) - 1;
            $json_without_bigints = \preg_replace('/:\s*(-?\d{' . $max_int_length . ',})/', ': "$1"', $input);
            $obj = \json_decode($json_without_bigints);
        }

        if ($errno = \json_last_error()) {
            static::handleJsonError($errno);
        } elseif ($obj === null && $input !== 'null') {
            throw new DomainException('Null result with non-null input');
        }
        return $obj;
    }

    /**
     *将PHP对象编码为JSON字符串。
     *
     *@param object|array$input PHP对象或数组
     *
     *@return string PHP对象或数组的JSON表示
     *
     *@throws DomainException提供的对象无法编码为有效的JSON
     */
    public static function jsonEncode($input)
    {
        $json = \json_encode($input);
        if ($errno = \json_last_error()) {
            static::handleJsonError($errno);
        } elseif ($json === 'null' && $input !== null) {
            throw new DomainException('Null result with non-null input');
        }
        return $json;
    }

    /**
     *使用URL安全Base64解码字符串。
     *
     *@param string$input Base64编码的字符串
     *
     *@return string解码后的字符串
     */
    public static function urlsafeB64Decode($input)
    {
        $remainder = \strlen($input) % 4;
        if ($remainder) {
            $padlen = 4 - $remainder;
            $input .= \str_repeat('=', $padlen);
        }
        return \base64_decode(\strtr($input, '-_', '+/'));
    }

    /**
     *使用URL安全Base64对字符串进行编码。
     *
     *@param string$input您想要编码的字符串
     *
     *@return string您传入内容的base64编码
     */
    public static function urlsafeB64Encode($input)
    {
        return \str_replace('=', '', \strtr(\base64_encode($input), '+/', '-_'));
    }

    /**
     *确定是否为每个密钥提供了算法
     *
     *@param Key|array＜Key＞|混合$keyOrKeyArray
     *@param string | null$kid
     *
     *@throws UnexpectedValueException
     *
     *@return数组，包含keyMaterial和算法
     */
    private static function getKeyMaterialAndAlgorithm($keyOrKeyArray, $kid = null)
    {
        if (
            is_string($keyOrKeyArray)
            || is_resource($keyOrKeyArray)
            || $keyOrKeyArray instanceof OpenSSLAsymmetricKey
        ) {
            return array($keyOrKeyArray, null);
        }

        if ($keyOrKeyArray instanceof Key) {
            return array($keyOrKeyArray->getKeyMaterial(), $keyOrKeyArray->getAlgorithm());
        }

        if (is_array($keyOrKeyArray) || $keyOrKeyArray instanceof ArrayAccess) {
            if (!isset($kid)) {
                throw new UnexpectedValueException('"kid" empty, 无法查找正确的密钥');
            }
            if (!isset($keyOrKeyArray[$kid])) {
                throw new UnexpectedValueException('"kid" invalid, 无法查找正确的密钥');
            }

            $key = $keyOrKeyArray[$kid];

            if ($key instanceof Key) {
                return array($key->getKeyMaterial(), $key->getAlgorithm());
            }

            return array($key, null);
        }

        throw new UnexpectedValueException(
            '$keyOrKeyArray 必须是字符串|资源键，字符串|资源密钥的数组，一个Firebase\JWT\Key键的实例或一个Firebase\JWT\ Key键的数组'
        );
    }

    /**
     * @param string $left
     * @param string $right
     * @return bool
     */
    public static function constantTimeEquals($left, $right)
    {
        if (\function_exists('hash_equals')) {
            return \hash_equals($left, $right);
        }
        $len = \min(static::safeStrlen($left), static::safeStrlen($right));

        $status = 0;
        for ($i = 0; $i < $len; $i++) {
            $status |= (\ord($left[$i]) ^ \ord($right[$i]));
        }
        $status |= (static::safeStrlen($left) ^ static::safeStrlen($right));

        return ($status === 0);
    }

    /**
     *用于创建JSON错误的Helper方法。
     *
     *@param int$errno json_last_error（）中的错误号
     *
     *@return void
     */
    private static function handleJsonError($errno)
    {
        $messages = array(
            JSON_ERROR_DEPTH => 'Maximum stack depth exceeded',
            JSON_ERROR_STATE_MISMATCH => 'Invalid or malformed JSON',
            JSON_ERROR_CTRL_CHAR => 'Unexpected control character found',
            JSON_ERROR_SYNTAX => 'Syntax error, malformed JSON',
            JSON_ERROR_UTF8 => 'Malformed UTF-8 characters', //PHP >= 5.3.3
        );
        throw new DomainException(
            isset($messages[$errno])
            ? $messages[$errno]
            : 'Unknown JSON error: ' . $errno
        );
    }

    /**
     *获取加密字符串中的字节数。
     *
     *@param string$str
     *
     *@return int
     */
    private static function safeStrlen($str)
    {
        if (\function_exists('mb_strlen')) {
            return \mb_strlen($str, '8bit');
        }
        return \strlen($str);
    }

    /**
     *将ECDSA签名转换为ASN.1 DER序列
     *
     *@param string$sig要转换的ECDSA签名
     *@return string编码的DER对象
     */
    private static function signatureToDER($sig)
    {
        //将签名分为r值和s值
        list($r, $s) = \str_split($sig, (int) (\strlen($sig) / 2));

        //修剪前导零
        $r = \ltrim($r, "\x00");
        $s = \ltrim($s, "\x00");

        //将无符号大端数整数的r值和s值转换为
        //有符号二的补码
        if (\ord($r[0]) > 0x7f) {
            $r = "\x00" . $r;
        }
        if (\ord($s[0]) > 0x7f) {
            $s = "\x00" . $s;
        }

        return self::encodeDER(
            self::ASN1_SEQUENCE,
            self::encodeDER(self::ASN1_INTEGER, $r) .
            self::encodeDER(self::ASN1_INTEGER, $s)
        );
    }

    /**
     *将值编码到DER对象中。
     *
     *@param int$type DER标记
     *@param string$value要编码的值
     *@return string编码对象
     */
    private static function encodeDER($type, $value)
    {
        $tag_header = 0;
        if ($type === self::ASN1_SEQUENCE) {
            $tag_header |= 0x20;
        }

        // Type
        $der = \chr($tag_header | $type);

        // Length
        $der .= \chr(\strlen($value));

        return $der . $value;
    }

    /**
     *对DER对象的签名进行编码。
     *
     *@param string$der der格式的二进制签名
     *@param int$keySize键中的位数
     *@return string签名
     */
    private static function signatureFromDER($der, $keySize)
    {
        //OpenSSL将ECDSA签名作为二进制ASN.1 DER SEQUENCE返回
        list($offset, $_) = self::readDER($der);
        list($offset, $r) = self::readDER($der, $offset);
        list($offset, $s) = self::readDER($der, $offset);

        //将r值和s值从有符号二的赞美转换为无符号
        //大端整数
        $r = \ltrim($r, "\x00");
        $s = \ltrim($s, "\x00");

        //填充r和s，使它们为$keySize位长
        $r = \str_pad($r, $keySize / 8, "\x00", STR_PAD_LEFT);
        $s = \str_pad($s, $keySize / 8, "\x00", STR_PAD_LEFT);

        return $r . $s;
    }

    /**
     *读取二进制DER编码数据并解码为单个对象
     *
     *@param string$der der格式的二进制数据
     *@param int$offset包含对象的数据流的偏移量
     *解码
     *@return array[$offset，$data]新偏移量和解码对象
     */
    private static function readDER($der, $offset = 0)
    {
        $pos = $offset;
        $size = \strlen($der);
        $constructed = (\ord($der[$pos]) >> 5)&0x01;
        $type = \ord($der[$pos++])&0x1f;

        // Length
        $len = \ord($der[$pos++]);
        if ($len&0x80) {
            $n = $len&0x1f;
            $len = 0;
            while ($n-- && $pos < $size) {
                $len = ($len << 8) | \ord($der[$pos++]);
            }
        }

        // Value
        if ($type == self::ASN1_BIT_STRING) {
            $pos++; //跳过第一个内容八位字节（填充指示符）
            $data = \substr($der, $pos, $len - 1);
            $pos += $len - 1;
        } elseif (!$constructed) {
            $data = \substr($der, $pos, $len);
            $pos += $len;
        } else {
            $data = null;
        }

        return array($pos, $data);
    }
}
